home *** CD-ROM | disk | FTP | other *** search
/ Night Owl 19 / Night Owl (The Best of Shareware)(NOPV 19)(1996).ISO / 031a / dirrpt13.zip / DIRRPT.DOC next >
Text File  |  1995-05-24  |  9KB  |  200 lines
  1.  
  2.                        DIRECTORY REPORT V1.3 USER'S GUIDE
  3.  
  4.                                  May 22, 1995
  5.  
  6.          1.0  GENERAL DESCRIPTION
  7.  
  8.          DIRRPT.EXE is a public domain MS-DOS utility to quickly determine
  9.          the directory/file structure of a drive, especially CDROMs and
  10.          large hard disks.  DIRRPT.EXE performs the following functions:
  11.  
  12.          a.  Scan a user specified drive and optional directory, to list
  13.              all subdirectory names with total files and total bytes in
  14.              each subdirectory.
  15.          b.  Show total files and total bytes for all directories in the
  16.              specified drive and optional directory.
  17.          c.  View the directory list using the cursor keys to scroll
  18.              backward and forward thru the directory list.
  19.          d.  Display a list of file names with size, date, time for each
  20.              highlighted directory by pressing the <Enter> key and using
  21.              the cursor keys to scroll backward and forward thru the file
  22.              list.
  23.          e.  Display the contents of a highlighted file by pressing the
  24.              <Enter> key and using the cursor keys to scroll forward,
  25.              backward, left, and right thru the file.
  26.          f.  Save the directory list, with or without individual file
  27.              information, to a user specified file.
  28.  
  29.          It is recommended that DIRRPT.EXE and this document, ASCII file
  30.          DIRRPT.DOC, be installed in a directory that is in the DOS PATH
  31.          statement so that DIRRPT can be run from any drive and
  32.          subdirectory.  DIRRPT uses the 80 column, 25 line text display
  33.          mode.
  34.  
  35.          2.0  MAIN MENU
  36.  
  37.          Use the cursor/enter keys or enter the first uppercase or
  38.          lowercase letter (g, v, s, h, q) to select the desired operation.
  39.  
  40.                            Get New Drive, Directory
  41.                                  View Report
  42.                              Save Report To File
  43.                                     Help
  44.                                 Quit Program
  45.  
  46.          The "Get New Drive, Directory" operation is required before the
  47.          "View Report" and "Save Report To File" operations.
  48.  
  49.          The following sections describe each operation.
  50.  
  51.          3.0  GET NEW DRIVE, DIRECTORY
  52.  
  53.          Load a new drive letter and optional directory to make it the
  54.          current drive\directory for the "View Report" and "Save Report To
  55.          File" operations. 
  56.  
  57.                                     - 2 -
  58.  
  59.                    DIRECTORY REPORT V1.3 USER'S GUIDE (Cont)
  60.  
  61.          If, at the "Enter drive:\dir(opt):" prompt, only the <Enter> key
  62.          is pressed, the current drive and root directory will be used.  If
  63.          only a drive letter is entered, the root directory of the drive
  64.          letter will be used.
  65.  
  66.          A drive and subdirectory(s) can be entered using the <Left>,
  67.          <Right>, <Home>, <End>, <BackSpace> and <Del> keys to edit the
  68.          entry.  Press the <Ins> key, to toggle editing between overstrike
  69.          mode (replace character at cursor) and insert mode (move character
  70.          at cursor to right).  Editing always starts in the overstrike
  71.          mode.
  72.  
  73.          The subdirectory entry can include wildcard characters "?" and
  74.          "*".  For example, C:\D* will list all directories on drive C
  75.          that begin with D, including all subdirectories in the DXXX
  76.          directory.
  77.  
  78.          The drive and subdirectory can also be entered on the command line
  79.          when DIRRPT is loaded.  For example, DIRRPT C will bypass the main
  80.          menu and list all directories on drive C.  The main menu will be
  81.          displayed after the quiting the "View Report" operation.
  82.  
  83.          The operation will be canceled if an invalid drive, invalid
  84.          directory or empty drive is requested.
  85.  
  86.          The directories will be scanned to acquire the file and byte
  87.          totals for each directory.  The list will be sorted in order of
  88.          directory name and then displayed as described in Section 4.1.
  89.          The total number of directories, files, and bytes will also be
  90.          displayed.
  91.  
  92.          The directory list will be the "current list" that is processed by
  93.          the "View Report" and "Save Report To File" operations until
  94.          another "Get New Drive, Directory" operation is performed.
  95.  
  96.          DIRRPT can process up to 2,048 directories, 2,048 files in each
  97.          directory, 65,535 total files, and 2,147,483,647 bytes in all
  98.          directories.
  99.  
  100.          On CDROM drives, if a "Drive not ready. Abort, Retry, Fail"
  101.          message occurs, press "r" to continue scanning the drive.
  102.  
  103.                                      - 3 -
  104.  
  105.                    DIRECTORY REPORT V1.3 USER'S GUIDE (Cont)
  106.  
  107.          4.0  VIEW REPORT
  108.  
  109.          4.1  Directory List
  110.  
  111.          Each line in the current directory list contains the complete
  112.          drive\directory name, and the number of files/bytes in that
  113.          directory only.  If the list is longer than will fit inside the
  114.          display window, a "More" indicator will appear at the top and/or
  115.          bottom of the window.  Use the <Up>, <Down>, <PgUp>, <PgDn>,
  116.          <Home>, and <End> keys to scroll one line backward/forward, one
  117.          screen backward/forward, and to the beginning/end of the list.
  118.          Press the <Esc> key to return to the main menu.
  119.  
  120.          4.2  File List
  121.  
  122.          To display the files in the highlighted directory, press the
  123.          <Enter> key to open another window.  The file list contains size,
  124.          date and time for each file, sorted in order of file name.  It is
  125.          scrolled in the same way as the directory list.  Hidden and system
  126.          files are included in the list.  Press the <Esc> key to return to
  127.          the directory list.
  128.  
  129.          4.3  File Viewer
  130.  
  131.          To display the contents of the highlighted file, press the <Enter>
  132.          key.  A full screen window shows the contents of the file. Use the
  133.          <Up>, <Down>, <PgUp>, <PgDn>, <Home>, and <End> keys to scroll
  134.          one line backward/forward, one screen backward/forward, and to the
  135.          beginning/end of the file.  Use the <Left> and <Right> keys to
  136.          scan left/right 8 columns.  Use the <Ctrl-Left> key to position
  137.          the 1st column of text to the left edge of the display.  Use the
  138.          <Ctrl-Home> key to perform the <Ctrl-Left> function and go to the
  139.          beginning of the file.  Non-text files (.EXE, .COM, .SYS, .BIN,
  140.          etc.) don't show a meaningful display.  The viewer can display the
  141.          first 16,000 lines of the file and up to 255 characters per line.
  142.          If the line contains more than 255 characters before the CR/LF
  143.          characters, it is wrapped to the next line.  Press the <Esc> key
  144.          to return to the file list.
  145.  
  146.          5.0  SAVE REPORT TO FILE
  147.  
  148.          The current directory list, with optional individual file info, is
  149.          saved to a user specified file name.  The program asks "Include
  150.          each file's name, size, date, and time? (Y/N) ".  Press "y" or "Y"
  151.          to include individual file info in the report.  Next, the program
  152.          asks "Enter file name (Esc: Cancel): DIRRPT.LST".  Press <Enter>
  153.          only to accept the default file name or enter/edit a file name and
  154.          optional directory as described in Section 3.0.  If only the <Esc>
  155.          key is pressed, the operation will be canceled. 
  156.  
  157.                                      - 4 -
  158.  
  159.                    DIRECTORY REPORT V1.3 USER'S GUIDE (Cont)
  160.  
  161.          If the specified file already exists, the program asks "File
  162.          already exists.  Overwrite? (Y/N) ".  Press "y" or "Y" to
  163.          overwrite the specified file.  Press "n" or "N" to  cancel the
  164.          operation and return to the main menu.
  165.  
  166.          An ASCII text file is generated.  The first line contains the
  167.          drive\directory name being scanned with the total number of
  168.          directories, files and bytes for all directories in the list.  The
  169.          second line is blank.  The third line is the names of the list
  170.          columns (Dir, Files, Bytes).  The rest of the lines are the
  171.          directory list as displayed in Section 4.1 and optional file list
  172.          for each directory as displayed in Section 4.2.
  173.  
  174.          6.0 HELP
  175.  
  176.          "Help" provides a brief description of DIRRPT.  Press any key to
  177.          return to the main menu.
  178.  
  179.          7.0  REVISION HISTORY
  180.  
  181.          1.0  Initial release.
  182.  
  183.          1.1  Add a file viewer individual file data option to Report To
  184.               File operation.
  185.  
  186.          1.2  Correct bug in individual file data option of Report To File
  187.               that causes computer to lockup.
  188.  
  189.          1.3  Add wildcard character (?, *) option to directory entry.
  190.               Allow initial drive and directory to entered on the command
  191.               line when loading DIRRPT.
  192.  
  193.          8.0  ADDITIONAL INFORMATION
  194.  
  195.          For additional information, comments, or suggestions on the
  196.          DIRRPT Directory Report program, contact John Haluska,
  197.          74000.1106@compuserve.com.
  198.  
  199.          DIRRPT.DOC 
  200.